<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="connectors_v1.html">Connectors API</a> . <a href="connectors_v1.projects.html">projects</a> . <a href="connectors_v1.projects.locations.html">locations</a> . <a href="connectors_v1.projects.locations.connections.html">connections</a> . <a href="connectors_v1.projects.locations.connections.eventSubscriptions.html">eventSubscriptions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, eventSubscriptionId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new EventSubscription in a given project,location and connection.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single EventSubscription.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single EventSubscription.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List EventSubscriptions in a given project,location and connection.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the parameters of a single EventSubscription.</p>
<p class="toc_element">
  <code><a href="#retry">retry(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">RetryEventSubscription retries the registration of Subscription.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, eventSubscriptionId=None, x__xgafv=None)</code>
  <pre>Creates a new EventSubscription in a given project,location and connection.

Args:
  parent: string, Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*` (required)
  body: object, The request body.
    The object takes the form of:

{ # represents the Connector&#x27;s EventSubscription resource
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Created time.
  &quot;destinations&quot;: { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
    &quot;endpoint&quot;: { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
      &quot;endpointUri&quot;: &quot;A String&quot;, # Optional. The URI of the Endpoint.
      &quot;headers&quot;: [ # Optional. List of Header to be added to the Endpoint.
        { # Header details for a given header to be added to Endpoint.
          &quot;key&quot;: &quot;A String&quot;, # Optional. Key of Header.
          &quot;value&quot;: &quot;A String&quot;, # Optional. Value of Header.
        },
      ],
    },
    &quot;pubsub&quot;: { # Pub/Sub message includes details of the Destination Pub/Sub topic. # OPTION 3: Write the event to Pub/Sub topic.
      &quot;attributes&quot;: { # Optional. Pub/Sub message attributes to be added to the Pub/Sub message.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;configVariables&quot;: [ # Optional. Configuration for configuring the trigger
        { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
          &quot;boolValue&quot;: True or False, # Value is a bool.
          &quot;encryptionKeyValue&quot;: { # Encryption Key value. # Value is a Encryption Key.
            &quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
            &quot;type&quot;: &quot;A String&quot;, # Type.
          },
          &quot;intValue&quot;: &quot;A String&quot;, # Value is an integer
          &quot;key&quot;: &quot;A String&quot;, # Optional. Key of the config variable.
          &quot;secretValue&quot;: { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
            &quot;secretVersion&quot;: &quot;A String&quot;, # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
          },
          &quot;stringValue&quot;: &quot;A String&quot;, # Value is a string.
        },
      ],
      &quot;projectId&quot;: &quot;A String&quot;, # Required. The project id which has the Pub/Sub topic.
      &quot;topicId&quot;: &quot;A String&quot;, # Required. The topic id of the Pub/Sub topic.
    },
    &quot;serviceAccount&quot;: &quot;A String&quot;, # Optional. Service account needed for runtime plane to trigger IP workflow.
    &quot;type&quot;: &quot;A String&quot;, # Optional. type of the destination
  },
  &quot;eventTypeId&quot;: &quot;A String&quot;, # Optional. Event type id of the event of current EventSubscription.
  &quot;jms&quot;: { # JMS message denotes the source of the event # Optional. JMS is the source for the event listener.
    &quot;name&quot;: &quot;A String&quot;, # Optional. Name of the JMS source. i.e. queueName or topicName
    &quot;type&quot;: &quot;A String&quot;, # Optional. Type of the JMS Source. i.e. Queue or Topic
  },
  &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
  &quot;status&quot;: { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
    &quot;description&quot;: &quot;A String&quot;, # Output only. Description of the state.
    &quot;state&quot;: &quot;A String&quot;, # Output only. State of Event Subscription resource.
  },
  &quot;subscriber&quot;: &quot;A String&quot;, # Optional. name of the Subscriber for the current EventSubscription.
  &quot;subscriberLink&quot;: &quot;A String&quot;, # Optional. Link for Subscriber of the current EventSubscription.
  &quot;triggerConfigVariables&quot;: [ # Optional. Configuration for configuring the trigger
    { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
      &quot;boolValue&quot;: True or False, # Value is a bool.
      &quot;encryptionKeyValue&quot;: { # Encryption Key value. # Value is a Encryption Key.
        &quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
        &quot;type&quot;: &quot;A String&quot;, # Type.
      },
      &quot;intValue&quot;: &quot;A String&quot;, # Value is an integer
      &quot;key&quot;: &quot;A String&quot;, # Optional. Key of the config variable.
      &quot;secretValue&quot;: { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
        &quot;secretVersion&quot;: &quot;A String&quot;, # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
      },
      &quot;stringValue&quot;: &quot;A String&quot;, # Value is a string.
    },
  ],
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
}

  eventSubscriptionId: string, Required. Identifier to assign to the Event Subscription. Must be unique within scope of the parent resource.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a single EventSubscription.

Args:
  name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/eventsubscriptions/*` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets details of a single EventSubscription.

Args:
  name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # represents the Connector&#x27;s EventSubscription resource
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Created time.
  &quot;destinations&quot;: { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
    &quot;endpoint&quot;: { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
      &quot;endpointUri&quot;: &quot;A String&quot;, # Optional. The URI of the Endpoint.
      &quot;headers&quot;: [ # Optional. List of Header to be added to the Endpoint.
        { # Header details for a given header to be added to Endpoint.
          &quot;key&quot;: &quot;A String&quot;, # Optional. Key of Header.
          &quot;value&quot;: &quot;A String&quot;, # Optional. Value of Header.
        },
      ],
    },
    &quot;pubsub&quot;: { # Pub/Sub message includes details of the Destination Pub/Sub topic. # OPTION 3: Write the event to Pub/Sub topic.
      &quot;attributes&quot;: { # Optional. Pub/Sub message attributes to be added to the Pub/Sub message.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;configVariables&quot;: [ # Optional. Configuration for configuring the trigger
        { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
          &quot;boolValue&quot;: True or False, # Value is a bool.
          &quot;encryptionKeyValue&quot;: { # Encryption Key value. # Value is a Encryption Key.
            &quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
            &quot;type&quot;: &quot;A String&quot;, # Type.
          },
          &quot;intValue&quot;: &quot;A String&quot;, # Value is an integer
          &quot;key&quot;: &quot;A String&quot;, # Optional. Key of the config variable.
          &quot;secretValue&quot;: { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
            &quot;secretVersion&quot;: &quot;A String&quot;, # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
          },
          &quot;stringValue&quot;: &quot;A String&quot;, # Value is a string.
        },
      ],
      &quot;projectId&quot;: &quot;A String&quot;, # Required. The project id which has the Pub/Sub topic.
      &quot;topicId&quot;: &quot;A String&quot;, # Required. The topic id of the Pub/Sub topic.
    },
    &quot;serviceAccount&quot;: &quot;A String&quot;, # Optional. Service account needed for runtime plane to trigger IP workflow.
    &quot;type&quot;: &quot;A String&quot;, # Optional. type of the destination
  },
  &quot;eventTypeId&quot;: &quot;A String&quot;, # Optional. Event type id of the event of current EventSubscription.
  &quot;jms&quot;: { # JMS message denotes the source of the event # Optional. JMS is the source for the event listener.
    &quot;name&quot;: &quot;A String&quot;, # Optional. Name of the JMS source. i.e. queueName or topicName
    &quot;type&quot;: &quot;A String&quot;, # Optional. Type of the JMS Source. i.e. Queue or Topic
  },
  &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
  &quot;status&quot;: { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
    &quot;description&quot;: &quot;A String&quot;, # Output only. Description of the state.
    &quot;state&quot;: &quot;A String&quot;, # Output only. State of Event Subscription resource.
  },
  &quot;subscriber&quot;: &quot;A String&quot;, # Optional. name of the Subscriber for the current EventSubscription.
  &quot;subscriberLink&quot;: &quot;A String&quot;, # Optional. Link for Subscriber of the current EventSubscription.
  &quot;triggerConfigVariables&quot;: [ # Optional. Configuration for configuring the trigger
    { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
      &quot;boolValue&quot;: True or False, # Value is a bool.
      &quot;encryptionKeyValue&quot;: { # Encryption Key value. # Value is a Encryption Key.
        &quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
        &quot;type&quot;: &quot;A String&quot;, # Type.
      },
      &quot;intValue&quot;: &quot;A String&quot;, # Value is an integer
      &quot;key&quot;: &quot;A String&quot;, # Optional. Key of the config variable.
      &quot;secretValue&quot;: { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
        &quot;secretVersion&quot;: &quot;A String&quot;, # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
      },
      &quot;stringValue&quot;: &quot;A String&quot;, # Value is a string.
    },
  ],
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>List EventSubscriptions in a given project,location and connection.

Args:
  parent: string, Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*` (required)
  filter: string, Filter.
  orderBy: string, Order by parameters.
  pageSize: integer, Page size.
  pageToken: string, Page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ConnectorsService.ListEventSubscriptions
  &quot;eventSubscriptions&quot;: [ # Subscriptions.
    { # represents the Connector&#x27;s EventSubscription resource
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Created time.
      &quot;destinations&quot;: { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
        &quot;endpoint&quot;: { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
          &quot;endpointUri&quot;: &quot;A String&quot;, # Optional. The URI of the Endpoint.
          &quot;headers&quot;: [ # Optional. List of Header to be added to the Endpoint.
            { # Header details for a given header to be added to Endpoint.
              &quot;key&quot;: &quot;A String&quot;, # Optional. Key of Header.
              &quot;value&quot;: &quot;A String&quot;, # Optional. Value of Header.
            },
          ],
        },
        &quot;pubsub&quot;: { # Pub/Sub message includes details of the Destination Pub/Sub topic. # OPTION 3: Write the event to Pub/Sub topic.
          &quot;attributes&quot;: { # Optional. Pub/Sub message attributes to be added to the Pub/Sub message.
            &quot;a_key&quot;: &quot;A String&quot;,
          },
          &quot;configVariables&quot;: [ # Optional. Configuration for configuring the trigger
            { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
              &quot;boolValue&quot;: True or False, # Value is a bool.
              &quot;encryptionKeyValue&quot;: { # Encryption Key value. # Value is a Encryption Key.
                &quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
                &quot;type&quot;: &quot;A String&quot;, # Type.
              },
              &quot;intValue&quot;: &quot;A String&quot;, # Value is an integer
              &quot;key&quot;: &quot;A String&quot;, # Optional. Key of the config variable.
              &quot;secretValue&quot;: { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
                &quot;secretVersion&quot;: &quot;A String&quot;, # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
              },
              &quot;stringValue&quot;: &quot;A String&quot;, # Value is a string.
            },
          ],
          &quot;projectId&quot;: &quot;A String&quot;, # Required. The project id which has the Pub/Sub topic.
          &quot;topicId&quot;: &quot;A String&quot;, # Required. The topic id of the Pub/Sub topic.
        },
        &quot;serviceAccount&quot;: &quot;A String&quot;, # Optional. Service account needed for runtime plane to trigger IP workflow.
        &quot;type&quot;: &quot;A String&quot;, # Optional. type of the destination
      },
      &quot;eventTypeId&quot;: &quot;A String&quot;, # Optional. Event type id of the event of current EventSubscription.
      &quot;jms&quot;: { # JMS message denotes the source of the event # Optional. JMS is the source for the event listener.
        &quot;name&quot;: &quot;A String&quot;, # Optional. Name of the JMS source. i.e. queueName or topicName
        &quot;type&quot;: &quot;A String&quot;, # Optional. Type of the JMS Source. i.e. Queue or Topic
      },
      &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
      &quot;status&quot;: { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
        &quot;description&quot;: &quot;A String&quot;, # Output only. Description of the state.
        &quot;state&quot;: &quot;A String&quot;, # Output only. State of Event Subscription resource.
      },
      &quot;subscriber&quot;: &quot;A String&quot;, # Optional. name of the Subscriber for the current EventSubscription.
      &quot;subscriberLink&quot;: &quot;A String&quot;, # Optional. Link for Subscriber of the current EventSubscription.
      &quot;triggerConfigVariables&quot;: [ # Optional. Configuration for configuring the trigger
        { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
          &quot;boolValue&quot;: True or False, # Value is a bool.
          &quot;encryptionKeyValue&quot;: { # Encryption Key value. # Value is a Encryption Key.
            &quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
            &quot;type&quot;: &quot;A String&quot;, # Type.
          },
          &quot;intValue&quot;: &quot;A String&quot;, # Value is an integer
          &quot;key&quot;: &quot;A String&quot;, # Optional. Key of the config variable.
          &quot;secretValue&quot;: { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
            &quot;secretVersion&quot;: &quot;A String&quot;, # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
          },
          &quot;stringValue&quot;: &quot;A String&quot;, # Value is a string.
        },
      ],
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Next page token.
  &quot;unreachable&quot;: [ # Locations that could not be reached.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the parameters of a single EventSubscription.

Args:
  name: string, Required. Identifier. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription} (required)
  body: object, The request body.
    The object takes the form of:

{ # represents the Connector&#x27;s EventSubscription resource
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Created time.
  &quot;destinations&quot;: { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
    &quot;endpoint&quot;: { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
      &quot;endpointUri&quot;: &quot;A String&quot;, # Optional. The URI of the Endpoint.
      &quot;headers&quot;: [ # Optional. List of Header to be added to the Endpoint.
        { # Header details for a given header to be added to Endpoint.
          &quot;key&quot;: &quot;A String&quot;, # Optional. Key of Header.
          &quot;value&quot;: &quot;A String&quot;, # Optional. Value of Header.
        },
      ],
    },
    &quot;pubsub&quot;: { # Pub/Sub message includes details of the Destination Pub/Sub topic. # OPTION 3: Write the event to Pub/Sub topic.
      &quot;attributes&quot;: { # Optional. Pub/Sub message attributes to be added to the Pub/Sub message.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;configVariables&quot;: [ # Optional. Configuration for configuring the trigger
        { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
          &quot;boolValue&quot;: True or False, # Value is a bool.
          &quot;encryptionKeyValue&quot;: { # Encryption Key value. # Value is a Encryption Key.
            &quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
            &quot;type&quot;: &quot;A String&quot;, # Type.
          },
          &quot;intValue&quot;: &quot;A String&quot;, # Value is an integer
          &quot;key&quot;: &quot;A String&quot;, # Optional. Key of the config variable.
          &quot;secretValue&quot;: { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
            &quot;secretVersion&quot;: &quot;A String&quot;, # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
          },
          &quot;stringValue&quot;: &quot;A String&quot;, # Value is a string.
        },
      ],
      &quot;projectId&quot;: &quot;A String&quot;, # Required. The project id which has the Pub/Sub topic.
      &quot;topicId&quot;: &quot;A String&quot;, # Required. The topic id of the Pub/Sub topic.
    },
    &quot;serviceAccount&quot;: &quot;A String&quot;, # Optional. Service account needed for runtime plane to trigger IP workflow.
    &quot;type&quot;: &quot;A String&quot;, # Optional. type of the destination
  },
  &quot;eventTypeId&quot;: &quot;A String&quot;, # Optional. Event type id of the event of current EventSubscription.
  &quot;jms&quot;: { # JMS message denotes the source of the event # Optional. JMS is the source for the event listener.
    &quot;name&quot;: &quot;A String&quot;, # Optional. Name of the JMS source. i.e. queueName or topicName
    &quot;type&quot;: &quot;A String&quot;, # Optional. Type of the JMS Source. i.e. Queue or Topic
  },
  &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
  &quot;status&quot;: { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
    &quot;description&quot;: &quot;A String&quot;, # Output only. Description of the state.
    &quot;state&quot;: &quot;A String&quot;, # Output only. State of Event Subscription resource.
  },
  &quot;subscriber&quot;: &quot;A String&quot;, # Optional. name of the Subscriber for the current EventSubscription.
  &quot;subscriberLink&quot;: &quot;A String&quot;, # Optional. Link for Subscriber of the current EventSubscription.
  &quot;triggerConfigVariables&quot;: [ # Optional. Configuration for configuring the trigger
    { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
      &quot;boolValue&quot;: True or False, # Value is a bool.
      &quot;encryptionKeyValue&quot;: { # Encryption Key value. # Value is a Encryption Key.
        &quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
        &quot;type&quot;: &quot;A String&quot;, # Type.
      },
      &quot;intValue&quot;: &quot;A String&quot;, # Value is an integer
      &quot;key&quot;: &quot;A String&quot;, # Optional. Key of the config variable.
      &quot;secretValue&quot;: { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
        &quot;secretVersion&quot;: &quot;A String&quot;, # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
      },
      &quot;stringValue&quot;: &quot;A String&quot;, # Value is a string.
    },
  ],
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
}

  updateMask: string, Required. The list of fields to update. Fields are specified relative to the Subscription. A field will be overwritten if it is in the mask. You can modify only the fields listed below. To update the EventSubscription details: * `serviceAccount`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="retry">retry(name, body=None, x__xgafv=None)</code>
  <pre>RetryEventSubscription retries the registration of Subscription.

Args:
  name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ConnectorsService.RefreshEventSubscription
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

</body></html>